docs: fix 0.1.4 documentation gaps and enforce API doc hygiene#70
Merged
Conversation
…workMockResourceLoader - Section.kt: add NETWORK to all KDoc bulleted lists (Section Organization, Default Icons, Icon Mapping); add KDoc to containerColor and contentColor extension properties which had none - Module.kt: add Section.NETWORK to the Available Sections KDoc list - theming.md: fix containerColour/contentColour typos → containerColor/contentColor; fix invalid MaterialTheme usage in non-composable context (use Color literals); add section-derived defaults table (v0.1.4+); replace Dokka placeholder link - custom-modules.md: add containerColor/contentColor to Module interface listing; replace Dokka placeholder link - networkmock.md: replace Dokka placeholder link; remove redundant trailing line - networkmock-core.md: add NetworkMockResourceLoader section (added in v0.1.3) with signature, basic usage, DI example, and rationale Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- CLAUDE.md: new Documentation Hygiene section — any metalava api.txt change must be accompanied by KDoc and doc site updates; checklist covers source KDoc, module pages, theming guide, custom-modules guide, and code samples - update-docs skill: renamed to "4 coordinated changes", added step 4 for verifying KDoc is in sync (enum entries, extension properties, bulleted lists); added table row for changed enum entries/extension properties Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
detekt runs with autoCorrect=true, so the pre-commit hook was silently rewriting files and leaving the corrections as unstaged diffs. Added `git diff --exit-code` after detektFull so the hook fails when auto- corrections occur, forcing them to be reviewed and re-staged before the commit lands. Also commits the ktlint formatting fixes that detekt had already applied to the UI refresh files (import ordering, indentation, trailing commas). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
MaxMichel2
added
bug
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Section.NETWORKmissing from all three bulleted KDoc lists inSection.kt;containerColor/contentColorextension properties had no KDoc at all;Module.kt## Available Sectionslist was missingNETWORKcontainerColour/contentColourtypos intheming.md(wrong spelling and invalidMaterialThemeusage in a non-composable context);NetworkMockResourceLoader(added in v0.1.3) had no doc page; three Dokka placeholder links resolved;containerColor/contentColormissing from the Module interface listing incustom-modules.md; section-derived color defaults table added for v0.1.4detektruns withautoCorrect = truebut the hook was silently leaving corrections as unstaged diffs. Addedgit diff --exit-codeafterdetektFullso the hook fails when auto-corrections occur, forcing them to be staged before the commit lands. Applied the pending ktlint corrections from the UI refresh files in the same commit.Test plan
.\gradlew.bat detektFullpasses./scripts/build_docs.sh --prep-onlycompletes without error (regenerates Dokka with updated KDoc, copies CHANGELOG)theming.mdcolor table,networkmock-core.mdNetworkMockResourceLoadersection,custom-modules.mdModule interface listing🤖 Generated with Claude Code